<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="CursorManager,mx.managers.CursorManager,NO_CURSOR,currentCursorID,currentCursorXOffset,currentCursorYOffset,getInstance,hideCursor,removeAllCursors,removeBusyCursor,removeCursor,setBusyCursor,setCursor,showCursor" name="keywords">
<title>mx.managers.CursorManager</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'CursorManager - Zentrum virtUOS: virtPresenter';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">virtPresenter AsDoc</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?mx/managers/CursorManager.html&amp;mx/managers/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;CursorManager</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#styleSummary">Styles</a>&nbsp;| <a href="#constantSummary">Constants</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class CursorManager"); titleBar_setSubNav(true,true,true,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">mx.managers</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class CursorManager</td>
</tr>
</table>
<p></p>
  The CursorManager class controls a prioritized list of cursors,
  where the cursor with the highest priority is currently visible.
  If the cursor list contains more than one cursor with the same priority,
  the Cursor Manager displays the most recently created cursor.
  
  <p>For example, if your application performs processing
  that requires the user to wait until the processing completes,
  you can change the cursor so that it reflects the waiting period.
  In this case, you can change the cursor to an hourglass
  or other image.</p>
  
  <p>You also might want to change the cursor to provide feedback
  to the user to indicate the actions that the user can perform.
  For example, you can use one cursor image to indicate that user input
  is enabled, and another to indicate that input is disabled. 
  You can use a JPEG, GIF, PNG, or SVG image, a Sprite object, or a SWF file
  as the cursor image.</p>
  
  <p>All methods and properties of the CursorManager are static,
  so you do not need to create an instance of it.</p>
   <p>In AIR, each mx.core.Window instance uses its own instance of the CursorManager class. 
  Instead of directly referencing the static methods and properties of the CursorManager class, 
  use the <code>Window.cursorManager</code> property to reference the CursorManager instance 
  for the Window instance. </p>
   <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="../managers/CursorManagerPriority.html" target="">mx.managers.CursorManagerPriority</a>
<br>mx.core.Window</div>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#currentCursorID">currentCursorID</a> : int<div class="summaryTableDescription">[static]
      ID of the current custom cursor,
      or NO_CURSOR if the system cursor is showing.</div>
</td><td class="summaryTableOwnerCol">CursorManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#currentCursorXOffset">currentCursorXOffset</a> : Number<div class="summaryTableDescription">[static]
      The x offset of the custom cursor, in pixels,
      relative to the mouse pointer.</div>
</td><td class="summaryTableOwnerCol">CursorManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#currentCursorYOffset">currentCursorYOffset</a> : Number<div class="summaryTableDescription">[static]
      The y offset of the custom cursor, in pixels,
      relative to the mouse pointer.</div>
</td><td class="summaryTableOwnerCol">CursorManager</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getInstance()">getInstance</a>():ICursorManager</div>
<div class="summaryTableDescription">[static]
      Each mx.core.Window instance in an AIR application has its own CursorManager instance.</div>
</td><td class="summaryTableOwnerCol">CursorManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#hideCursor()">hideCursor</a>():void</div>
<div class="summaryTableDescription">[static]
      Makes the cursor invisible.</div>
</td><td class="summaryTableOwnerCol">CursorManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#removeAllCursors()">removeAllCursors</a>():void</div>
<div class="summaryTableDescription">[static]
      Removes all of the cursors from the cursor list
      and restores the system cursor.</div>
</td><td class="summaryTableOwnerCol">CursorManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#removeBusyCursor()">removeBusyCursor</a>():void</div>
<div class="summaryTableDescription">[static]
      Removes the busy cursor from the cursor list.</div>
</td><td class="summaryTableOwnerCol">CursorManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#removeCursor()">removeCursor</a>(cursorID:int):void</div>
<div class="summaryTableDescription">[static]
      Removes a cursor from the cursor list.</div>
</td><td class="summaryTableOwnerCol">CursorManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setBusyCursor()">setBusyCursor</a>():void</div>
<div class="summaryTableDescription">[static]
      Displays the busy cursor.</div>
</td><td class="summaryTableOwnerCol">CursorManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setCursor()">setCursor</a>(cursorClass:Class, priority:int = 2, xOffset:Number = 0, yOffset:Number = 0):int</div>
<div class="summaryTableDescription">[static]
      Creates a new cursor and sets an optional priority for the cursor.</div>
</td><td class="summaryTableOwnerCol">CursorManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#showCursor()">showCursor</a>():void</div>
<div class="summaryTableDescription">[static]
      Makes the cursor visible.</div>
</td><td class="summaryTableOwnerCol">CursorManager</td>
</tr>
</table>
</div>
<a name="styleSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Styles</div>
<table id="summaryTableStyle" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Style</th><th>Description</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"><a name="style:busyCursor"></a>&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<span class="signatureLink">busyCursor</span>
</div>
</td><td class="summaryTableDescription"><span class="label">Type: </span>Class &nbsp; <span class="label">CSS Inheritance: </span>no<br>
  The skin for the busy cursor
    The default value is <code>mx.skins.halo.BusyCursor</code>.</td><td class="summaryTableOwnerCol">CursorManager</td>
</tr>
</table>
</div>
<a name="constantSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Constants</div>
<table id="summaryTableConstant" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#NO_CURSOR">NO_CURSOR</a> : int = 0<div class="summaryTableDescription">[static]
      Constant that is the value of <code>currentCursorID</code> property
      when there is no cursor managed by the CursorManager and therefore
      the system cursor is being displayed.</div>
</td><td class="summaryTableOwnerCol">CursorManager</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="currentCursorID"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">currentCursorID</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>currentCursorID:int</code>&nbsp;&nbsp;[read-write]<p>
      ID of the current custom cursor,
      or NO_CURSOR if the system cursor is showing.
     </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public static function get currentCursorID():int</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set currentCursorID(value:int):void</code>
<br>
</div>
<a name="currentCursorXOffset"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">currentCursorXOffset</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>currentCursorXOffset:Number</code>&nbsp;&nbsp;[read-write]<p>
      The x offset of the custom cursor, in pixels,
      relative to the mouse pointer.
           
      </p><p>The default value is <code>0</code>.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public static function get currentCursorXOffset():Number</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set currentCursorXOffset(value:Number):void</code>
<br>
</div>
<a name="currentCursorYOffset"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">currentCursorYOffset</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>currentCursorYOffset:Number</code>&nbsp;&nbsp;[read-write]<p>
      The y offset of the custom cursor, in pixels,
      relative to the mouse pointer.
           </p><p>The default value is <code>0</code>.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public static function get currentCursorYOffset():Number</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set currentCursorYOffset(value:Number):void</code>
<br>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="getInstance()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getInstance</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public static function getInstance():ICursorManager</code><p>
      Each mx.core.Window instance in an AIR application has its own CursorManager instance. 
      This method returns the CursorManager instance for the main Window instance.  
           </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>ICursorManager</code> &mdash; The CursorManager instance for the main Window instance in an AIR application.  
     </td>
</tr>
</table>
</div>
<a name="hideCursor()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">hideCursor</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function hideCursor():void</code><p>
      Makes the cursor invisible.
      Cursor visibility is not reference-counted.
      A single call to the <code>hideCursor()</code> method
      always hides the cursor regardless of how many calls
      to the <code>showCursor()</code> method were made.
     
      </p><p>Calling this method does not affect the system cursor. 
      Use the <code>Mouse.show()</code> and 
      <code>Mouse.hide()</code> methods to directly 
      control the system cursor. </p>
     </div>
<a name="removeAllCursors()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">removeAllCursors</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function removeAllCursors():void</code><p>
      Removes all of the cursors from the cursor list
      and restores the system cursor.
     </p></div>
<a name="removeBusyCursor()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">removeBusyCursor</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function removeBusyCursor():void</code><p>
      Removes the busy cursor from the cursor list.
      If other busy cursor requests are still active in the cursor list,
      which means you called the <code>setBusyCursor()</code> method more than once,
      a busy cursor does not disappear until you remove
      all busy cursors from the list.
     </p></div>
<a name="removeCursor()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">removeCursor</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function removeCursor(cursorID:int):void</code><p>
      Removes a cursor from the cursor list.
      If the cursor being removed is the currently displayed cursor,
      the CursorManager displays the next cursor in the list, if one exists.
      If the list becomes empty, the CursorManager displays
      the default system cursor.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">cursorID</span>:int</code> &mdash; ID of cursor to remove.
     </td>
</tr>
</table>
</div>
<a name="setBusyCursor()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setBusyCursor</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function setBusyCursor():void</code><p>
      Displays the busy cursor.
      The busy cursor has a priority of CursorManagerPriority.LOW.
      Therefore, if the cursor list contains a cursor
      with a higher priority, the busy cursor is not displayed 
      until you remove the higher priority cursor.
      To create a busy cursor at a higher priority level,
      use the <code>setCursor()</code> method.
     </p></div>
<a name="setCursor()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setCursor</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function setCursor(cursorClass:Class, priority:int = 2, xOffset:Number = 0, yOffset:Number = 0):int</code><p>
      Creates a new cursor and sets an optional priority for the cursor.
      Adds the new cursor to the cursor list.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">cursorClass</span>:Class</code> &mdash; Class of the cursor to display.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">priority</span>:int</code> (default = <code>2</code>)<code></code> &mdash; Integer that specifies
      the priority level of the cursor.
      Possible values are <code>CursorManagerPriority.HIGH</code>,
      <code>CursorManagerPriority.MEDIUM</code>, and <code>CursorManagerPriority.LOW</code>.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">xOffset</span>:Number</code> (default = <code>0</code>)<code></code> &mdash; Number that specifies the x offset
      of the cursor, in pixels, relative to the mouse pointer.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">yOffset</span>:Number</code> (default = <code>0</code>)<code></code> &mdash; Number that specifies the y offset
      of the cursor, in pixels, relative to the mouse pointer.
           </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>int</code> &mdash; The ID of the cursor.
           </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../managers/CursorManagerPriority.html" target="">mx.managers.CursorManagerPriority</a>
</div>
</div>
<a name="showCursor()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">showCursor</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function showCursor():void</code><p>
      Makes the cursor visible.
      Cursor visibility is not reference-counted.
      A single call to the <code>showCursor()</code> method
      always shows the cursor regardless of how many calls
      to the <code>hideCursor()</code> method were made.
           </p><p>Calling this method does not affect the system cursor. 
      Use the <code>Mouse.show()</code> and 
      <code>Mouse.hide()</code> methods to directly 
      control the system cursor. </p>
     </div>
<a name="constantDetail"></a>
<div class="detailSectionHeader">Constant detail</div>
<a name="NO_CURSOR"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">NO_CURSOR</td><td class="detailHeaderType">constant</td>
</tr>
</table>
<div class="detailBody">
<code>public static const NO_CURSOR:int = 0</code><p>
      Constant that is the value of <code>currentCursorID</code> property
      when there is no cursor managed by the CursorManager and therefore
      the system cursor is being displayed.
     </p></div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
